API endpoints

Washing machines and washer-dryers

The base URL for all paths is https://create-energy-label.service.gov.uk. No authentication is required for any endpoints.

Washer-dryers: arrow image

Path

/api/v1/washing-machines/washer-dryer/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
productPriceHeightPx	Enter height of the product's price (in pixels). This may be up to 3 digits long.	Integer
labelOrientation	Arrow direction. Must be one of: LEFT RIGHT	String
labelFormat	Image format. Must be one of: JPEG PNG	String
labelColour	The colour of the arrow image. Use a colour arrow if you can. You can use a black and white arrow if your material is being printed in black and white. You shouldn't use black and white arrows on the internet. Must be one of: COLOUR BLACK_AND_WHITE	String
efficiencyRating	Energy efficiency class indicator. Must be one of: A B C D E F G	String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "labelColour": "COLOUR", "efficiencyRating": "A" }

Washer-dryers: energy label

You must attach the label to the front or top of the product so that it’s easy to see. If it's a built-in washer-dryer it doesn't have to be attached to the product, but it must still be easy to see. It must be at least 96mm x 192mm when printed.

Path

/api/v1/washing-machines/washer-dryer/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
outputFormat	Format of the generated label. Optional, defaults to PDF if not set. Must be one of: PDF PNG JPEG	String
supplierName	Supplier's name or trade mark.	String
modelName	Supplier's model identification code.	String
completeCycleEfficiencyRating	Energy efficiency class for the complete cycle. Must be one of: A B C D E F G	String
washingCycleEfficiencyRating	Energy efficiency class for the washing cycle. Must be one of: A B C D E F G	String
completeCycleEnergyConsumption	Weighted energy consumption per 100 complete cycles in kWh, rounded to the nearest integer. This may be up to 3 digits long.	Integer
washingCycleEnergyConsumption	Weighted energy consumption per 100 washing cycles in kWh, rounded to the nearest integer. This may be up to 3 digits long.	Integer
completeCycleCapacity	Rated capacity for the complete cycle in Kg. This may be up to 2 digits long with an optional 1 decimal place.	Number
washingCycleCapacity	Rated capacity for the washing cycle in Kg. This may be up to 2 digits long with an optional 1 decimal place.	Number
completeCycleWaterConsumption	Weighted water consumption per complete cycle in litres, rounded to the nearest integer. This may be up to 2 digits long.	Integer
washingCycleWaterConsumption	Weighted water consumption per washing cycle in litres, rounded to the nearest integer. This may be up to 2 digits long.	Integer
completeCycleDurationHours	Number of hours for the complete cycle, up to 1 digit. If the complete cycle is under 1 hour, enter 0. This may be up to 1 digit long.	Integer
completeCycleDurationMinutes	Number of minutes for the complete cycle, between 0 and 59.	Integer
washingCycleDurationHours	Number of hours for the washing cycle, up to 1 digit. If the washing cycle is under 1 hour, enter 0. This may be up to 1 digit long.	Integer
washingCycleDurationMinutes	Number of minutes for the washing cycle, between 0 and 59.	Integer
spinDryingEfficiencyRating	Spin drying efficiency class. Must be one of: A B C D E F G	String
noiseEmissionClass	Airborne acoustic noise emission class of the spinning phase of the eco 40-60 programme. Must be one of: A B C D	String
noiseEmissionValue	Airborne acoustic noise emission of the spinning phase of the eco 40-60 programme in dB(A) re 1 pW, rounded to the nearest integer. This may be up to 2 digits long.	Integer
qrCodeUrl	Enter a link to the product information sheet. Links must start with http:// or https:// and contain at least one dot (.) character.	String

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "completeCycleEfficiencyRating": "A", "washingCycleEfficiencyRating": "A", "completeCycleEnergyConsumption": 1, "washingCycleEnergyConsumption": 1, "completeCycleCapacity": 1.1, "washingCycleCapacity": 1.1, "completeCycleWaterConsumption": 1, "washingCycleWaterConsumption": 1, "completeCycleDurationHours": 1, "completeCycleDurationMinutes": 1, "washingCycleDurationHours": 1, "washingCycleDurationMinutes": 1, "spinDryingEfficiencyRating": "A", "noiseEmissionClass": "A", "noiseEmissionValue": 1, "qrCodeUrl": "https://example.com" }

Washing machines: arrow image

Path

/api/v1/washing-machines/washing-machines/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
productPriceHeightPx	Enter height of the product's price (in pixels). This may be up to 3 digits long.	Integer
labelOrientation	Arrow direction. Must be one of: LEFT RIGHT	String
labelFormat	Image format. Must be one of: JPEG PNG	String
labelColour	The colour of the arrow image. Use a colour arrow if you can. You can use a black and white arrow if your material is being printed in black and white. You shouldn't use black and white arrows on the internet. Must be one of: COLOUR BLACK_AND_WHITE	String
efficiencyRating	Energy efficiency class indicator. Must be one of: A B C D E F G	String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "labelColour": "COLOUR", "efficiencyRating": "A" }

Washing machines: energy label

You must attach the label to the front or top of the product so that it’s easy to see. If it's a built-in washing machine it doesn't have to be attached to the product, but it must still be easy to see. Labels must be at least 96mm x 192mm when printed.

Path

/api/v1/washing-machines/washing-machines/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
outputFormat	Format of the generated label. Optional, defaults to PDF if not set. Must be one of: PDF PNG JPEG	String
supplierName	Supplier's name or trade mark.	String
modelName	Supplier's model identification code.	String
efficiencyRating	Energy efficiency class indicator. Must be one of: A B C D E F G	String
spinDryingEfficiencyRating	Spin-drying efficiency class. Must be one of: A B C D E F G	String
energyConsumptionPer100Cycles	Weighted energy consumption per 100 cycles in kWh, rounded to the nearest integer. This may be up to 3 digits long.	Integer
ecoRatedCapacity	Rated capacity in Kg for the the eco 40-60 programme. This may be up to 2 digits long with an optional 1 decimal place.	Number
waterConsumptionPerCycle	Weighted water consumption per cycle in litres, rounded to the nearest integer. This may be up to 2 digits long.	Integer
programmeDurationHours	Hours duration of the eco 40-60 programme at rated capacity. This may be up to 1 digit long.	Integer
programmeDurationMinutes	Minutes duration of the eco 40-60 programme at rated capacity.	Integer
noiseEmissionClass	Airborne acoustic noise emission class. Must be one of: A B C D	String
noiseEmissionValue	Airborne acoustic noise emission of the spinning phase in dB(A) re 1 pW, rounded to the nearest integer. This may be up to 2 digits long.	Integer
qrCodeUrl	Enter a link to the product information sheet. Links must start with http:// or https:// and contain at least one dot (.) character.	String

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "efficiencyRating": "A", "spinDryingEfficiencyRating": "A", "energyConsumptionPer100Cycles": 1, "ecoRatedCapacity": 1.1, "waterConsumptionPerCycle": 1, "programmeDurationHours": 1, "programmeDurationMinutes": 1, "noiseEmissionClass": "A", "noiseEmissionValue": 1, "qrCodeUrl": "https://example.com" }